home *** CD-ROM | disk | FTP | other *** search
/ Network CD 2 / Network CD - Volume 2.iso / programs / internet / terminal / xcomm100a.lha / x-comm / documentation / X-CommRexx.Manual < prev    next >
Encoding:
Text File  |  1993-01-11  |  17.1 KB  |  343 lines
  1. X-Comm ARexx Manual
  2. ­­­­­­­­­­­­­­­­­­­
  3.  
  4.         This  manual  describes  X-Comm's  ARexx port and commands allowed.
  5. Because  multiple  versions  of X-Comm can be run, each ARexx port for each
  6. version  run  will  be called something different.  The original ARexx port
  7. belonging  to the first version run will be called 'X-Comm'.  From then on,
  8. the ports will be called 'X-Comm.1', 'X-Comm.2' and so on.
  9.  
  10.         The first word in the command list is the actual ARexx command (Not
  11. case  sensitive).  If the command has any arguments, they will be listed in
  12. <  >  brackets after the command.  After that, a description of the command
  13. will follow.
  14.  
  15. X-Comm ARexx Command List
  16. ­­­­­­­­­­­­­­­­­­­­­­­­­
  17.  
  18. XToFront - Brings X-Comm screen to front.
  19.  
  20. WBToFront - Brings Workbench to Front.
  21.  
  22. XGet  <variable> - Gets information about the current X-Comm configuration.
  23.                    Please  see the list on 'XGet/Set Variables' later on in
  24.                    this  manual for a full list of available variables.  An
  25.                    example may be:
  26.  
  27.                         XGet  "BaudRate"  would put the current baudrate in
  28.                         'result'.
  29.  
  30. XClearWaitStrings - Clears the current waitstring list.
  31.  
  32. XAddWaitString <string> - Adds a string to the waitstring list for use with
  33.                           the 'XWaitStringList' command.
  34.  
  35. XStickBuffer - Sticks the X-Comm review buffer.
  36.  
  37. XUnstickbuffer - Unsticks X-Comm review buffer.
  38.  
  39. XOpenReview - Opens the X-Comm review buffer.
  40.  
  41. XCloseReview - Closes the X-Comm review buffer.
  42.  
  43. XFlushBuffer - Clears the X-Comm review buffer.
  44.  
  45. XClearDial - Clears the X-Comm dial list.
  46.  
  47. XRedial - Re-Dials the numbers in the dial list.
  48.  
  49. XCloseCapture - Closes any opened capture files.
  50.  
  51. XPrinterOn - Turns printer output on.
  52.  
  53. XPrinterOff - Turns printer output off.
  54.  
  55. XString  <string> - Parses  <string> through X-Comm's autoinsert parser and
  56.                     returns  the  output  in  'result'.   Things  like '\n'
  57.                     (newline)  and  '\r' (carriage return) will be converted
  58.                     to proper ASCII and things like '%u' (username) will be
  59.                     properly   converted.    It  is  recommened  that  this
  60.                     function  be  used  frequently to keep ARexx code clean
  61.                     (free of weird ASCII charcters.)
  62.  
  63. XLoadBuffer <filename> - Loads <filename> into X-Comm's review buffer.
  64.  
  65. XAppendBuffer <filename> - Appends <filename> to the X-Comm buffer.
  66.  
  67. XSaveBuffer <filename> - Saves the review buffer to <filename>.
  68.  
  69. XSleep  <value> - Causes  a  delay  of  <value>  * 0.02 seconds.  The ARexx
  70.                   script will be halted during this time.
  71.  
  72. XMacro <macro name> - Executes an X-Comm Macro by name.
  73.  
  74. XAddDial <system name> - Adds <system name> to the dial list.
  75.  
  76. XManualDial <number> - Manually dials <number> through the X-Comm dialer.
  77.  
  78. XSystemDial  <system name> - Clears the dial list and dials a single system
  79.                              name.
  80.  
  81. XSystemSelect <system name> - Like the 'Select System' menu in 'Phonebook'.
  82.                               If  you  have a carrier present, you can tell
  83.                               X-Comm  what  system  you  are online to, and
  84.                               X-Comm will load all nessacery configurations
  85.                               that  go  with  the system and set to all the
  86.                               nessacery settings.
  87.  
  88. XOpenCapture <filename> - Opens a new capture file with the name <filename>
  89.  
  90. XAppendCapture  <filename> - Opens a capture file and appends it to the end
  91.                              of an existing file.
  92.  
  93. XLoad  <filetype> - Loads  an  X-Comm  settings  file  depending  on  what
  94.                     <filetype>  you  pass.  The file loaded will be the one
  95.                     X-Comm currently has set.  Filetypes:
  96.  
  97.                             Config - Current configuration.
  98.                             Rates - Current rates file.
  99.                             Macros - Current macros file.
  100.                             Diallist - Current X-Comm dial list.
  101.                             Phone - Current phonebook file.
  102.                             Filetypes - Current X-Comm filetypes file (Only
  103.                                         valid   in  registered  version  of
  104.                                         X-Comm).
  105.  
  106.                     Note  that the actual filenames to load can be set with
  107.                     XSet.
  108.  
  109. XSave  <filetype> - Same  as  XLoad,  except  it  saves the file instead of
  110.                     loading it.
  111.  
  112. XScreenPrint  <string> - Outputs  <string>  to X-Comm's terminal.  Does not
  113.                          get  sent to the modem.  Note:  If you want X-Comm
  114.                          variables  to  be used in these strings then first
  115.                          format  the  string  using the XString first.  For
  116.                          example  to  display the time and date and current
  117.                          system  name  into  the  string the function calls
  118.                          would be:
  119.  
  120.                                 XString "%d %t %S"
  121.                                 XScreenPrint result
  122.  
  123. XSerialPrint  <string> - Outputs <string> to the modem only.  Charcater may
  124.                          get  printed to the terminal if the system 'echos'
  125.                          the  characters  back.   Note:  If you want X-Comm
  126.                          variables  to  be used in these strings then first
  127.                          format  the  string  using the XString first.  For
  128.                          example  to  display the time and date and current
  129.                          system  name  into  the  string the function calls
  130.                          would be:
  131.  
  132.                                 XString "%d %t %S"
  133.                                 XSerialPrint result
  134.  
  135. XModemPrint  <string> - Outputs  <string>  to  the  modem AND the terminal.
  136.                         This  is  usually only useful if the system doesn't
  137.                         echo  charcters back (which isn't very often.) Most
  138.                         of  the time, XSerialPrint will be the best command
  139.                         to  use.  Note:  If you want X-Comm variables to be
  140.                         used  in these strings then first format the string
  141.                         using  the  XString  first.  For example to display
  142.                         the  time and date and current system name into the
  143.                         string the function calls would be.
  144.  
  145.                                 XString "%d %t %S"
  146.                                 XModemPrint result
  147.  
  148. XWaitStringList  <timeout>  -  Waits  for  all the strings contained in the
  149.                                Wait  String list (Set with XAddWaitString.)
  150.                                Will  either  wait for one of the strings to
  151.                                arrive through the serial port, or will wait
  152.                                for  the  timeout  value  to  expire.  If no
  153.                                timeout   is  specified,  a  default  of  10
  154.                                seconds is applied.  The timeout value is in
  155.                                seconds.  If one of the strings being waited
  156.                                on  arrives,  this  function will return the
  157.                                string it received in 'result'.
  158.  
  159. XMenu  <(menu#,item#,subitem#)> - This  function  executes  one of X-Comm's
  160.                                   menus.     Menu#   corresponds   to   the
  161.                                   horizonal   menu   which   the   item  is
  162.                                   contained.   Item#  is  the actually menu
  163.                                   item  number.   Subitem#  is  the subitem
  164.                                   that  you  may be referencing.  Note that
  165.                                   '~~~~~~~~~'  break  lines in the menu ARE
  166.                                   counted   as   items.   For  example,  to
  167.                                   execute  the 'Load Config / Load From...'
  168.                                   menu  item,  you  would  put this line in
  169.                                   your ARexx script:
  170.  
  171.                                         XMenu "(0,2,1)"
  172.  
  173.                                   remembering  that  '~~~~~~~~' are counted
  174.                                   and  all  references  are  taken starting
  175.                                   from 0.
  176.  
  177. XSet  <variable>  <value> - Sets  an  X-Comm configuration item, similar to
  178.                             XGet.     <item>   corresponds   to   something
  179.                             like  'Baudrate'  or 'Emulation'.  Value is the
  180.                             value you would like it set to. Ie
  181.  
  182.                                 XSet "Baudrate" "2400"
  183.  
  184.                             would set your current baudrate to 2400.
  185.  
  186.                             See the later section on XGet/XSet variables.
  187.  
  188. XWaitString  <string>  <timeout> - Waits  for  <string>  for  a  specified
  189.                                    <timeout>   value.   If  the  string  is
  190.                                    found,  X-Comm will return the string in
  191.                                    'result'.   If  it  times  out,  then ""
  192.                                    (nothing) will be returned in result.
  193.  
  194. XRequestChoice  <Buttons>  <String> - Opens  a  standard  ReqTools  Choice
  195.                                       requester  and  displays <String> and
  196.                                       the  quiestion being asked.  <String>
  197.                                       can contain multiple words as long as
  198.                                       the  whole sentence is placed with in
  199.                                       any  standard  ARexx  delimiters  (eg
  200.                                       ',").  <Buttons> are the Names of the
  201.                                       buttons that you wish to be placed on
  202.                                       the  requester, this should be in the
  203.                                       form "Button_1|Button_2|...|Button_N"
  204.                                       The  Function  will return the number
  205.                                       of the gadget that was selected.  Any
  206.                                       of  the  arguments can be replaced by
  207.                                       "-" to use a default value.
  208.  
  209. XRequestFile <Path> <Pattern> <String> - This will being up a ReqTools file
  210.                                          requester,  with  the default path
  211.                                          set  to  the  value of <Path>, the
  212.                                          pattern  gadget will use <Pattern>
  213.                                          and the description stirng will be
  214.                                          set  to <String>.  The Name of the
  215.                                          file  selected  will  be return in
  216.                                          result.   Any of the arguments can
  217.                                          be   replaced  by  "-"  to  use  a
  218.                                          default value.
  219.  
  220. XRequestString  <String> - This  will  bring  up  a ReqTools string gadget,
  221.                            using  <String>  as  the  Requester description.
  222.                            The   string  entered  is  returned  in  result.
  223.                            <String>  may be replaced by "-" for the defualt
  224.                            value.
  225.  
  226. XDownLoad  <FileName> - This  will  start  a  download,  using  the default
  227.                         protocol.   If  this  protocol is not batchable (ie
  228.                         XModem)  then  a  filename  should  be given as the
  229.                         argument.   Otherwise  "-"  must  be  given  as the
  230.                         argument   and   the   filename   will   be  gotten
  231.                         automatically by the transfers.
  232.  
  233. XUpload  <FileName_1>  ... - This  will  attemp  a file transfer of all the
  234.                              files  given  as  the  arguments.   If you are
  235.                              using  a  non-batchable  protocol  (ie XModem)
  236.                              then  only  the  first  file will be uploaded,
  237.                              otherwise   all   files  will  be  sent.   The
  238.                              filenames should be given one after the other,
  239.                              seperated  by a space or any other valid ARexx
  240.                              argument seperator.
  241.  
  242. XAsciiSend <FileName> - This will preform an ASCII Send of the <FileName>.
  243.  
  244. XGetString  <Character> - This  functions read input from the serial device
  245.                           or  local console until <character> is read.  All
  246.                           data  received up until and including <character>
  247.                           will be returned in result.
  248.  
  249. XHangup - Hangs up the modem.
  250.  
  251. XGet/XSet Variables
  252. ­­­­­­­­­­­­­­­­­­­
  253.   
  254.  
  255.         This  is  a  list of all the gettable and setable values in X-Comm.
  256. Each value usually corresponds to an entry in the configuration file.
  257.  
  258.         Please  see  the description of the XGet and XSet commands for more
  259. information.   This is a list of the <variables> that can be used with both
  260. commands.  Some commands are only valid in XGet however, and those commands
  261. will have a comment saying so.
  262.  
  263. ARexxPath - The current ARexx path.
  264. FileTypesFile - The  currently  loaded  filetypes  filename  (only valid in
  265.                 registered versions.)
  266. BaudRate - The current baudrate.
  267. BufferPath - Current Bufferpath.
  268. CapturePath - Current Capturefile path.
  269. ConfigPath - Current Configuration path.
  270. Databits - Number of data bits.
  271. Duplex - Duplex (full or half.)
  272. Downloadpath - Current download path.
  273. DisplayID - HEX  value representing the current display mode
  274.             in use. (Onlu in XGet)
  275. DisplayName - The name of the current display ID. (Only in XGet)
  276. Emulation - Current XEM Emulation library (if using one.)
  277. Handshaking - Handshaking mode (None, CTS/RTS or XON-XOFF.)
  278. LogfilePath - Current log files path.
  279. Macropath - Current macro files path.
  280. Macrofile - The currently loaded macro filename.
  281. Parity - Parity. (None, Odd, Even, Space or Mark.)
  282. Phonebookpath - Current phonebook path.
  283. Phonebookfile - Currently loaded phonebook filename.
  284. Protocol - Current XPR Protocol name
  285. PublicScreenName - Name of the public screen X-Comm is on.  If X-Comm is on
  286.                    its  own  custom screen, the ScreenID of the screen will
  287.                    be returned.
  288. PublicScreen - Whether X-Comm is on a public screen or not. (ON/OFF)
  289. BackroundPattern - Whether  or  not the user has a backround pattern turned
  290.                    on.
  291. RateFile - Currently loaded call rates file.
  292. ScreenDepth - Depth  of  the  current  screen  in  bitplanes.  (Between 1-8
  293.               depending on machine and display mode.)
  294. SerialDevice - The currently used serial driver.
  295. SerialUnit - The unit of the serial driver in use.
  296. SerialShared - Whether the serial device is in shared mode. (ON/OFF)
  297. BufferStuck - If the review buffer window is in stuck mode. (ON/OFF)
  298. StopBits - Number of Stop bits in use.
  299. TermLeft - The Terminal window's left edge.
  300. TermTop - The Terminal window's top edge.
  301. TermWidth - The Terminal window's width (In pixels)
  302. TermHeight - The Terminal window's height (In pixels)
  303. TermType - Whether  you're  using  the XEM libraries or the console device.
  304.            ('XEM Libraries' or 'Console Device'.)
  305. TermBorder - Using a 3D border around the terminal window. (ON/OFF)
  306. PatternName - If using a backdrop pattern, this is the filename.
  307. TermShadow - Drop shadow under the terminal window. (ON/OFF)
  308. ScreenFont - The currently used Screen Font.
  309. ScreenFontSize - The currently used Screen Font Size.
  310. TermFont - The currently used Terminal Font.
  311. TermFontSize -The currently used Terminal Font Size.
  312. ModemInit - The current modem initialisation string.
  313. ModemHangup - The current modem hangup string.
  314. ModemConnect - The current modem CONNECT string.
  315. ModemBusy - The current modem BUSY string.
  316. ModemRing - The current modem RING string.
  317. ModemNoDialTone - The current modem NO DIALTONE string.
  318. ModemDialType - Whether 'Tone' or 'Pulse'.
  319. ModemDialPrefix1 - Currently set alternate dial prefix #1.
  320. ModemDialPrefix2 - Currently set alternate dial prefix #2.
  321. ModemDialPrefix3 - Currently set alternate dial prefix #3.
  322. CarrierCheck - Whether carrier checking is turned on. (ON/OFF)
  323. Titlebar - Whether the titlebar is enabled or not. (ON/OFF)
  324. UploadsPath - The current uploads path.
  325. FlashBeep - Whether X-Comm display will flash on beep. (ON/OFF)
  326. ToFrontBeep - Whether X-Comm comes to the front on a beep. (ON/OFF)
  327. UseSoundBeep - Whether X-Comm uses a a sound when beeping. (ON/OFF)
  328. BeepSound - Name of the beep sound filename in use (if at all.)
  329. ImmediateExit - Whether X-Comm will exit immediatly after selecting 'Quit'.
  330.                 (ON/OFF)
  331. SendString - The current anti-logoff send string.
  332. SendDelay - The current anti-logoff send delay.
  333. StripCaptureANSI - Whether ANSI strip filters are turned on. (ON/OFF)
  334. SwapDelBS - Whether the DEL and Backspace keys are swapped. (ON/OFF)
  335. VT100Cursor - Whether  X-Comm  remaps  cursor  keys  to VT100 style control
  336.               characters (ON/OFF)
  337. ASCIISendCharDelay - The current ASCII Send Charcter Delay.
  338. ASCIISendLineDelay - The current ASCII Send Line Delay.
  339. FileControlActive - If  file  control  is disabled or not.  Will be 'On' if
  340.                     file control is disabled.
  341. CreateIcons - Whether  X-Comm  will create icons for sucessfully downloaded
  342.               files.  (ON/OFF)
  343.